/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.dxf2.webmessage;

import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.function.BooleanSupplier;
import java.util.function.Supplier;
import org.hisp.dhis.feedback.Status;
import org.springframework.http.HttpStatus;

/**
 * @author Lars Helge Overland
 */
public class DescriptiveWebMessage extends WebMessage {
  private String description;

  /** Only for deserialisation */
  public DescriptiveWebMessage() {
    super();
  }

  public DescriptiveWebMessage(Status status, HttpStatus httpStatus) {
    super(status, httpStatus);
  }

  @JsonProperty
  public String getDescription() {
    return description;
  }

  public DescriptiveWebMessage setDescription(String description) {
    this.description = description;
    return this;
  }

  public DescriptiveWebMessage setDescription(BooleanSupplier when, Supplier<String> thenValue) {
    return when.getAsBoolean() ? setDescription(thenValue.get()) : this;
  }
}
